Skip to content

chore: change organization from metamask to bitcoindevkit #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 21, 2025

Conversation

notmandatory
Copy link
Member

@notmandatory notmandatory commented Aug 15, 2025

Description

Updated organization meta data that references metamask to bitcoindevkit.

Notes to the reviewers

I had to reduce the number of keywords in Cargo.toml to five to match what crates.io allows for the keywords field.

I also created this PR to trigger the CI so we can add those jobs to our default branch protection checks.

Changelog notice

  • Updated organization meta data that references metamask to bitcoindevkit.

Checklists

All Submissions:

  • I've signed all my commits
  • I followed the contribution guidelines
  • I ran cargo fmt and cargo clippy before committing

@notmandatory notmandatory self-assigned this Aug 15, 2025
@notmandatory
Copy link
Member Author

notmandatory commented Aug 15, 2025

@darioAnongba I didn't test publishing yet, I want to figure out first if we want to keep the NPM name "bitcoindevkit" or change it to "bdk_wasm". If we change it to `bdk_wasm" should we change the repo name also?

Since the organization name is now "bitcoindevkit" it seems weird to me have a package called "@bitcoindevkit/bitcoindevkit" rather than "@bitcoindevkit/bdk_wasm".

@darioAnongba
Copy link
Collaborator

darioAnongba commented Aug 19, 2025

I'm sure you're aware of it but just for precision. The @bitcoindevkit part of the NPM package name is the namespace, owned by an organization. We can only add that if BDK owns that namespace by creating an NPM account. Very similar to the name of the org on GH, which is bitcoindevkit (so makes sense to keep the same).

If we want this package to be the only one deployed by BDK on NPM, we can simply call it bitcoindevkit and drop the namespace but I wouldn't recommend that.
If we want to mimic as much as possible the structure of BDK, we could have something like:

  • @bitcoindevkit/wallet-web
  • @bitcoindevkit/wallet-node
  • @bitcoindevkit/esplora
  • @bitcoindevkit/bitcoind-rpc
  • ...

Note: NPM packages do not use underscore _, but use -.

@notmandatory
Copy link
Member Author

I agree with your suggestion and would like to use the bitcoindevkit namespace and unique names for the artifacts. I'm not a node user so if those names are typical then they look fine to me but would like to map more directly to what we call those crates in rust. How would this be:

  • @bitcoindevkit/bdk-wallet-web
  • @bitcoindevkit/bdk-wallet-node
  • @bitcoindevkit/bdk-esplora
  • @bitcoindevkit/bdk-electrum (node only)
  • @bitcoindevkit/bdk-bitcoind-rpc (node only)

@darioAnongba
Copy link
Collaborator

ACK, I think we can pull that off in the medium term. For now we can start with bdk-wallet-web to mimic what MetaMask had and then we can work on splitting into different NPM packages.
I'll let you know about ownership of the bitcoindevkit namespace on NPM.

@darioAnongba darioAnongba marked this pull request as ready for review August 21, 2025 09:33
@darioAnongba darioAnongba merged commit 3fce146 into bitcoindevkit:main Aug 21, 2025
10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants